package com.heima.api.admin;

import com.heima.model.admin.dtos.ChannelDto;
import com.heima.model.admin.pojos.AdChannel;
import com.heima.model.common.dtos.ResponseResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

/**
 * @ClassName ChannelControllerApi
 * @Description 频道管理控制层接口
 * @Author AWei
 * @DATE 2021/4/9 17:25
 * @Version 1.0
 */
@Api(value = "频道管理", tags = "channel", description = "频道管理API")
public interface ChannelControllerApi {

    /**
     * @param channelDto 分页数据以及频道名称 对象
     * @return 分页查询结果
     * @Description 分页查询频道信息或者根据名称分页查询
     */
    @ApiOperation("分页查询频道信息或者根据名称分页查询")
    ResponseResult queryChannelByPageOrName(ChannelDto channelDto);

    /**
     * @param channel 新增的频道对象
     * @return 新增结果
     * @Description 新增频道信息
     */
    @ApiOperation("新增频道信息")
    ResponseResult addChannel(AdChannel channel);

    /**
     * @param adChannel 被修改对象
     * @return 修改结果
     * @Description 频道修改和频道有效无效设置
     */
    @ApiOperation("频道修改和频道有效无效设置")
    ResponseResult modifyChannel(AdChannel adChannel);

    /**
     * @param id 被删除频道id
     * @return 删出结果
     * @Description 删除频道
     */
    @ApiOperation("删除频道")
    ResponseResult deleteChannelById(Integer id);

    /**
     * @return 查询结果
     * @Description 查询所有频道
     */
    @ApiOperation("查询所有频道")
    ResponseResult findAll();

}
